fix: split README check into PR-comment + main-update jobs #241
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Two issues with the current README check workflow: 1. PR comments were a single long unreadable line — now the PR job only posts a nicely formatted bulleted list of issues (no push) 2. The commit never actually got pushed because checkout used the merge ref (detached HEAD) instead of the PR branch New approach: - **PR job**: read-only check, posts a comment listing discrepancies. No commits pushed to the PR branch (keeps PRs clean). - **Main job**: triggers on push to main, actually updates README.md and pushes a commit with a descriptive bullet-list message. Closes #240 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
🚀 Package Preview Available!Install this PR's preview build with npm: npm i @base44-preview/cli@0.0.31-pr.241.c74aebbPrefer not to change any import paths? Install using npm alias so your code still imports npm i "base44@npm:@base44-preview/cli@0.0.31-pr.241.c74aebb"Or add it to your {
"dependencies": {
"base44": "npm:@base44-preview/cli@0.0.31-pr.241.c74aebb"
}
}
Preview published to npm registry — try new features instantly! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note
Description
This PR splits the README check workflow into two separate jobs: a read-only PR comment job that reports discrepancies without modifying the branch, and a main branch update job that automatically fixes the README after merges. This prevents polluting PR branches with automated commits while ensuring the README stays up-to-date on main. It also fixes bugs where PR comments were unreadable single lines and commits weren't actually pushed due to detached HEAD issues.
Related Issue
Closes #240
Type of Change
Changes Made
readme-checkjob into two separate jobs:readme-check-prandreadme-update-mainreadme-check-pr: Runs on pull requests, posts formatted comment listing issues without committingreadme-update-main: Runs on pushes to main, updates README.md and commits with descriptive messagecontents: read, main job hascontents: writeTesting
npm test)Checklist
Additional Notes
The workflow needs to be tested by:
This architectural change prevents automated commits from appearing in PR branches while maintaining automatic README synchronization on the main branch.
🤖 Generated by Claude | 2026-02-12 14:32 UTC